@gnosticdev/highlevel-sdk
Version:
SDK for the HighLevel API
1,421 lines • 193 kB
TypeScript
type paths = {
'/social-media-posting/{locationId}/accounts': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Accounts
* @description Get list of accounts and groups
*/
get: operations['get-account'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/social-media-posting/{locationId}/accounts/{id}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/**
* Delete Account
* @description Delete account and account from group
*/
delete: operations['delete-account'];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/social-media-posting/{locationId}/categories': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get categories by location id */
get: operations['get-categories-location-id'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/social-media-posting/{locationId}/categories/{id}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get categories by id */
get: operations['get-categories-id'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/social-media-posting/{locationId}/csv': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get Upload Status */
get: operations['get-upload-status'];
put?: never;
/** Upload CSV */
post: operations['upload-csv'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/social-media-posting/{locationId}/csv/{csvId}/post/{postId}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/** Delete CSV Post */
delete: operations['delete-csv-post'];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/social-media-posting/{locationId}/csv/{id}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get CSV Post */
get: operations['get-csv-post'];
put?: never;
post?: never;
/** Delete CSV */
delete: operations['delete-csv'];
options?: never;
head?: never;
/** Start CSV Finalize */
patch: operations['start-csv-finalize'];
trace?: never;
};
'/social-media-posting/{locationId}/posts': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create post
* @description Create posts for all supported platforms. It is possible to create customized posts per channel by using the same platform account IDs in a request and hitting the create post API multiple times with different summaries and account IDs per platform.
*
* The content and media limitations, as well as platform rate limiters corresponding to the respective platforms, are provided in the following reference link:
*
* Link: [Platform Limitations](https://help.leadconnectorhq.com/support/solutions/articles/48001240003-social-planner-image-video-content-and-api-limitations "Social Planner Help")
*/
post: operations['create-post'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/social-media-posting/{locationId}/posts/{id}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get post
* @description Get post
*/
get: operations['get-post'];
/**
* Edit post
* @description Create posts for all supported platforms. It is possible to create customized posts per channel by using the same platform account IDs in a request and hitting the create post API multiple times with different summaries and account IDs per platform.
*
* The content and media limitations, as well as platform rate limiters corresponding to the respective platforms, are provided in the following reference link:
*
* Link: [Platform Limitations](https://help.leadconnectorhq.com/support/solutions/articles/48001240003-social-planner-image-video-content-and-api-limitations "Social Planner Help")
*/
put: operations['edit-post'];
post?: never;
/**
* Delete Post
* @description Delete Post
*/
delete: operations['delete-post'];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/social-media-posting/{locationId}/posts/bulk-delete': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Bulk Delete Social Planner Posts
* @description Deletes multiple posts based on the provided list of post IDs.
* This operation is useful for clearing up large numbers of posts efficiently.
*
* Note:
*
* 1.The maximum number of posts that can be deleted in a single request is '50'.
*
* 2.However, It will only get deleted in Highlevel database but still
* it is recommended to be cautious of this operation.
*/
post: operations['bulk-delete-social-planner-posts'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/social-media-posting/{locationId}/posts/list': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Get posts
* @description Get Posts
*/
post: operations['get-posts'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/social-media-posting/{locationId}/set-accounts': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Set Accounts */
post: operations['set-accounts'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/social-media-posting/{locationId}/tags': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get tags by location id */
get: operations['get-tags-location-id'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/social-media-posting/{locationId}/tags/details': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Get tags by ids */
post: operations['get-tags-by-ids'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/social-media-posting/oauth/{locationId}/facebook/accounts/{accountId}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get facebook pages
* @description Get facebook pages
*/
get: operations['get-facebook-page-group'];
put?: never;
/**
* Attach facebook pages
* @description Attach facebook pages
*/
post: operations['attach-facebook-page-group'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/social-media-posting/oauth/{locationId}/google/locations/{accountId}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get google business locations
* @description Get google business locations
*/
get: operations['get-google-locations'];
put?: never;
/**
* Set google business locations
* @description Set google business locations
*/
post: operations['set-google-locations'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/social-media-posting/oauth/{locationId}/instagram/accounts/{accountId}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Instagram Professional Accounts
* @description Get Instagram Professional Accounts
*/
get: operations['get-instagram-page-group'];
put?: never;
/**
* Attach Instagram Professional Accounts
* @description Attach Instagram Professional Accounts
*/
post: operations['attach-instagram-page-group'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/social-media-posting/oauth/{locationId}/linkedin/accounts/{accountId}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Linkedin pages and profile
* @description Get Linkedin pages and profile
*/
get: operations['get-linkedin-page-profile'];
put?: never;
/**
* Attach linkedin pages and profile
* @description Attach linkedin pages and profile
*/
post: operations['attach-linkedin-page-profile'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/social-media-posting/oauth/{locationId}/tiktok-business/accounts/{accountId}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Tiktok Business profile
* @description Get Tiktok Business profile
*/
get: operations['get-tiktok-business-profile'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/social-media-posting/oauth/{locationId}/tiktok/accounts/{accountId}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Tiktok profile
* @description Get Tiktok profile
*/
get: operations['get-tiktok-profile'];
put?: never;
/**
* Attach Tiktok profile
* @description Attach Tiktok profile
*/
post: operations['attach-tiktok-profile'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/social-media-posting/oauth/{locationId}/twitter/accounts/{accountId}': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Twitter profile
* @deprecated
* @description <div><div>
* <span style= "display: inline-block;
* width: 25px; height: 25px;
* background-color: red;
* color: black;
* font-weight: bold;
* font-size: 24px;
* text-align: center;
* line-height: 20px;
* border: 2px solid black;
* border-radius: 20%;
* margin-right: 10px;">
* !
* </span>
* <span><strong>As of December 4, 2024, X (formerly Twitter) is no longer supported. We apologise for any inconvenience.</strong></span>
* </div></div>
*/
get: operations['get-twitter-profile'];
put?: never;
/**
* Attach Twitter profile
* @deprecated
* @description <div><div>
* <span style= "display: inline-block;
* width: 25px; height: 25px;
* background-color: red;
* color: black;
* font-weight: bold;
* font-size: 24px;
* text-align: center;
* line-height: 20px;
* border: 2px solid black;
* border-radius: 20%;
* margin-right: 10px;">
* !
* </span>
* <span><strong>As of December 4, 2024, X (formerly Twitter) is no longer supported. We apologise for any inconvenience.</strong></span>
* </div></div>
*/
post: operations['attach-twitter-profile'];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/social-media-posting/oauth/facebook/start': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Starts OAuth For Facebook Account
* @description Open the API in a window with appropriate params and headers instead of using the Curl. User is navigated to Facebook login OAuth screen. On successful login, listen on window object for message where event listener returns data in its callback function.
* ### Sample code to listen to event data:
* window.addEventListener('message',
* function(e) {
* if (e.data && e.data.page === 'social_media_posting') {
* const { actionType, page, platform, placement, accountId, reconnectAccounts } = e.data
* }
* },
* false)
* ### Event Data Response:
* {
* actionType: string, Ex: "close"
* page: string, Ex: "social-media-posting"
* platform: string, Ex: "facebook"
* placement: string, Ex: "placement"
* accountId: string, Ex: "658a9b6833b91e0ecb8f3958"
* reconnectAccounts: string[]] Ex: ["658a9b6833b91e0ecb834acd", "efd2daa9b6833b91e0ecb8f3511"]
* }
* ### The accountId retrieved from above data can be used to fetch Facebook account details using below API -
* API: '/social-media-posting/oauth/facebook/accounts/:accountId'
*
* Method: GET
*/
get: operations['start-facebook-oauth'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/social-media-posting/oauth/google/start': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Starts OAuth For Google Account
* @description Open the API in a window with appropriate params and headers instead of using the Curl. User is navigated to Google login OAuth screen. On successful login, listen on window object for message where event listener returns data in its callback function.
* ### Sample code to listen to event data:
* window.addEventListener('message',
* function(e) {
* if (e.data && e.data.page === 'social_media_posting') {
* const { actionType, page, platform, placement, accountId, reconnectAccounts } = e.data
* }
* },
* false)
* ### Event Data Response:
* {
* actionType: string, Ex: "close"
* page: string, Ex: "social-media-posting"
* platform: string, Ex: "google"
* placement: string, Ex: "placement"
* accountId: string, Ex: "658a9b6833b91e0ecb8f3958"
* reconnectAccounts: string[]] Ex: ["658a9b6833b91e0ecb834acd", "efd2daa9b6833b91e0ecb8f3511"]
* }
* ### The accountId retrieved from above data can be used to fetch Google account details using below API -
* API: '/social-media-posting/oauth/google/accounts/:accountId'
*
* Method: GET
*/
get: operations['start-google-oauth'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/social-media-posting/oauth/instagram/start': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Starts OAuth For Instagram Account
* @description Open the API in a window with appropriate params and headers instead of using the Curl. User is navigated to Instagram login OAuth screen. On successful login, listen on window object for message where event listener returns data in its callback function.
* ### Sample code to listen to event data:
* window.addEventListener('message',
* function(e) {
* if (e.data && e.data.page === 'social_media_posting') {
* const { actionType, page, platform, placement, accountId, reconnectAccounts } = e.data
* }
* },
* false)
* ### Event Data Response:
* {
* actionType: string, Ex: "close"
* page: string, Ex: "social-media-posting"
* platform: string, Ex: "instagram"
* placement: string, Ex: "placement"
* accountId: string, Ex: "658a9b6833b91e0ecb8f3958"
* reconnectAccounts: string[]] Ex: ["658a9b6833b91e0ecb834acd", "efd2daa9b6833b91e0ecb8f3511"]
* }
* ### The accountId retrieved from above data can be used to fetch Instagram account details using below API -
* API: '/social-media-posting/oauth/instagram/accounts/:accountId'
*
* Method: GET
*/
get: operations['start-instagram-oauth'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/social-media-posting/oauth/linkedin/start': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Starts OAuth For LinkedIn Account
* @description Open the API in a window with appropriate params and headers instead of using the Curl. User is navigated to LinkedIn login OAuth screen. On successful login, listen on window object for message where event listener returns data in its callback function.
* ### Sample code to listen to event data:
* window.addEventListener('message',
* function(e) {
* if (e.data && e.data.page === 'social_media_posting') {
* const { actionType, page, platform, placement, accountId, reconnectAccounts } = e.data
* }
* },
* false)
* ### Event Data Response:
* {
* actionType: string, Ex: "close"
* page: string, Ex: "social-media-posting"
* platform: string, Ex: "linkedin"
* placement: string, Ex: "placement"
* accountId: string, Ex: "658a9b6833b91e0ecb8f3958"
* reconnectAccounts: string[]] Ex: ["658a9b6833b91e0ecb834acd", "efd2daa9b6833b91e0ecb8f3511"]
* }
* ### The accountId retrieved from above data can be used to fetch LinkedIn account details using below API -
* API: '/social-media-posting/oauth/linkedin/accounts/:accountId'
*
* Method: GET
*/
get: operations['start-linkedin-oauth'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/social-media-posting/oauth/tiktok-business/start': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Starts OAuth For Tiktok Business Account
* @description Open the API in a window with appropriate params and headers instead of using the Curl. User is navigated to Tiktok-Business login OAuth screen. On successful login, listen on window object for message where event listener returns data in its callback function.
* ### Sample code to listen to event data:
* window.addEventListener('message',
* function(e) {
* if (e.data && e.data.page === 'social_media_posting') {
* const { actionType, page, platform, placement, accountId, reconnectAccounts } = e.data
* }
* },
* false)
* ### Event Data Response:
* {
* actionType: string, Ex: "close"
* page: string, Ex: "social-media-posting"
* platform: string, Ex: "tiktok-business"
* placement: string, Ex: "placement"
* accountId: string, Ex: "658a9b6833b91e0ecb8f3958"
* reconnectAccounts: string[]] Ex: ["658a9b6833b91e0ecb834acd", "efd2daa9b6833b91e0ecb8f3511"]
* }
* ### The accountId retrieved from above data can be used to fetch Tiktok-Business account details using below API -
* API: '/social-media-posting/oauth/tiktok-business/accounts/:accountId'
*
* Method: GET
*/
get: operations['start-tiktok-business-oauth'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/social-media-posting/oauth/tiktok/start': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Starts OAuth For Tiktok Account
* @description Open the API in a window with appropriate params and headers instead of using the Curl. User is navigated to Tiktok login OAuth screen. On successful login, listen on window object for message where event listener returns data in its callback function.
* ### Sample code to listen to event data:
* window.addEventListener('message',
* function(e) {
* if (e.data && e.data.page === 'social_media_posting') {
* const { actionType, page, platform, placement, accountId, reconnectAccounts } = e.data
* }
* },
* false)
* ### Event Data Response:
* {
* actionType: string, Ex: "close"
* page: string, Ex: "social-media-posting"
* platform: string, Ex: "tiktok"
* placement: string, Ex: "placement"
* accountId: string, Ex: "658a9b6833b91e0ecb8f3958"
* reconnectAccounts: string[]] Ex: ["658a9b6833b91e0ecb834acd", "efd2daa9b6833b91e0ecb8f3511"]
* }
* ### The accountId retrieved from above data can be used to fetch Tiktok account details using below API -
* API: '/social-media-posting/oauth/tiktok/accounts/:accountId'
*
* Method: GET
*/
get: operations['start-tiktok-oauth'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
'/social-media-posting/oauth/twitter/start': {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Starts OAuth For Twitter Account
* @deprecated
* @description <div><div>
* <span style= "display: inline-block;
* width: 25px; height: 25px;
* background-color: red;
* color: black;
* font-weight: bold;
* font-size: 24px;
* text-align: center;
* line-height: 20px;
* border: 2px solid black;
* border-radius: 20%;
* margin-right: 10px;">
* !
* </span>
* <span><strong>As of December 4, 2024, X (formerly Twitter) is no longer supported. We apologise for any inconvenience.</strong></span>
* </div></div>
*/
get: operations['start-twitter-oauth'];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
};
type webhooks = Record<string, never>;
type components = {
schemas: {
AccountsListResponseDTO: {
/**
* @description Message
* @example Fetched Accounts
*/
message: string;
/** @description Requested Results */
results?: components['schemas']['AccountsListResponseSchema'];
/**
* @description Status Code
* @example 200
*/
statusCode: number;
/**
* @description Success or Failure
* @example true
*/
success: boolean;
};
AccountsListResponseSchema: {
accounts?: components['schemas']['GetAccountSchema'][];
groups?: components['schemas']['GetGroupSchema'][];
};
AttachFBAccountDTO: {
/** @example https://storage.googleapis.com/2ad21ebc23/test */
avatar?: string;
/**
* @description Company ID
* @example sdfdsfdsfEWEsdfsdsW32dd
*/
companyId?: string;
/** @example JOHN_DEO */
name?: string;
/** @example 244405****11687 */
originId?: string;
/** @example page */
type?: Record<string, never>;
};
AttachGMBLocationDTO: {
account?: Record<string, never>;
/**
* @description Company ID
* @example sdfdsfdsfEWEsdfsdsW32dd
*/
companyId?: string;
location?: Record<string, never>;
};
AttachIGAccountDTO: {
avatar?: string;
/**
* @description Company ID
* @example sdfdsfdsfEWEsdfsdsW32dd
*/
companyId?: string;
/** @example JOHN_DEO */
name?: string;
/** @example 244405****11687 */
originId?: string;
/** @example 234234234242sd */
pageId: string;
};
AttachLinkedinAccountDTO: {
avatar?: string;
/**
* @description Company ID
* @example sdfdsfdsfEWEsdfsdsW32dd
*/
companyId?: string;
/** @example JOHN_DEO */
name?: string;
/** @example 244405****11687 */
originId?: string;
/** @enum {string} */
type?: 'page' | 'group' | 'profile' | 'location' | 'business';
urn?: string;
};
AttachTiktokAccountDTO: {
avatar?: string;
/**
* @description Company ID
* @example sdfdsfdsfEWEsdfsdsW32dd
*/
companyId?: string;
/** @example JOHN_DEO */
name?: string;
/** @example 244405****11687 */
originId?: string;
/** @enum {string} */
type?: 'page' | 'group' | 'profile' | 'location' | 'business';
/** @example JOHN_DEO */
username?: string;
/** @example true */
verified?: boolean;
};
AttachTwitterAccountDTO: {
avatar?: string;
/**
* @description Company ID
* @example sdfdsfdsfEWEsdfsdsW32dd
*/
companyId?: string;
/** @example JOHN_DEO */
name?: string;
/** @example 244405****11687 */
originId?: string;
/** @example true */
protected?: boolean;
/** @example user_name */
username?: string;
/** @example true */
verified?: boolean;
};
BadRequestDTO: {
/** @example Bad Request */
message?: string;
/** @example 400 */
statusCode?: number;
};
BulkDeletePostSuccessfulResponseSchema: {
deletedCount?: number;
};
BulkDeleteResponseDto: {
/**
* @description Message
* @example Posts Deleted Successfully
*/
message: string;
/**
* @description Message and deleted count
* @example {
* "deletedCount": 10,
* "message": "Posts deleted successfully"
* }
*/
results: unknown;
/**
* @description Status Code
* @example 201
*/
statusCode: number;
/**
* @description Success or Failure
* @example true
*/
success: boolean;
};
CategorySchema: {
/**
* @description ID
* @example Lx1EI6YIgQYMQi0ytFXv
*/
_id?: string;
/**
* Format: date-time
* @example 2023-08-02T00:00:00.000Z
*/
createdAt?: string;
/**
* @description Created By User
* @example Lx1EI6YIgQYMQi0ytFXv
*/
createdBy?: string;
/**
* @description Deleted Value
* @example false
*/
deleted: boolean;
/**
* @description Location ID
* @example Lx1EI6YIgQYMQi0ytFXv
*/
locationId?: string;
/**
* @description Category Name
* @example Primary
*/
name?: string;
/**
* @description Color For Category
* @example #FFFFFF
*/
primaryColor?: string;
/**
* @description Secondary Color
* @example #FFFFFF
*/
secondaryColor?: string;
/**
* Format: date-time
* @example 2023-08-02T00:00:00.000Z
*/
updatedAt?: string;
};
CreatePostDTO: {
/**
* @description Account Ids
* @example [
* "aF3KhyL8JIuBwzK3m7Ly_iVrVJ2uoXNF0wzcBzgl5_12554616564525983496"
* ]
*/
accountIds?: string[];
/**
* @description Category Id
* @example 65f151c99bc2bf3aaf970d72
*/
categoryId?: string;
/** @description Created By */
createdBy?: string;
/**
* @description Follow Up Comment on platform. It is not allowed on Tiktok and GMB accounts and there is a limit of 280 charecters for twitter account
* @example First comment
*/
followUpComment?: string;
/** @description GMB Post Details */
gmbPostDetails?: components['schemas']['GMBPostSchema'];
/** @description Post Media Data
* The limitations of media as per the platforms is provided through the reference link in API description */
media?: components['schemas']['PostMediaSchema'][];
/** @description Og Tags Meta Data */
ogTagsDetails?: components['schemas']['OgTagsSchema'];
/** @description Post Approval Details */
postApprovalDetails?: components['schemas']['PostApprovalSchema'];
/** @description Schedule Date */
scheduleDate?: string;
/**
* @description if schedule datetime is updated
* @example true
*/
scheduleTimeUpdated?: boolean;
/**
* @description Status must be one of the following values: null, in_progress, draft, failed, published, scheduled, in_review, notification_sent, deleted
* @example draft
*/
status?: Record<string, never>;
/**
* @description Post Content
* The limitations of content as per the platforms is provided through the reference link in API description. The summary will be trimmed based on the limit
* @example Hello World
*/
summary?: string;
/**
* @description Array of Tag Value
* @example [
* "65f151c99bc2bf3aaf970d72"
* ]
*/
tags?: string[];
/** @description Tiktok Post Details */
tiktokPostDetails?: components['schemas']['TiktokPostSchema'];
/**
* @description Post Type must be one of the following values: - post, story, reel
* @example post
*/
type: Record<string, never>;
/**
* @description User ID
* @example sdfdsfdsfEWEsdfsdsW32dd
*/
userId?: string;
};
CreatePostSuccessfulResponseDTO: {
/**
* @description Message
* @example Created Post
*/
message: string;
/** @description Requested Results */
results?: components['schemas']['CreatePostSuccessfulResponseSchema'];
/**
* @description Status Code
* @example 201
*/
statusCode: number;
/**
* @description Success or Failure
* @example true
*/
success: boolean;
};
CreatePostSuccessfulResponseSchema: {
/** @description Post Data */
post?: components['schemas']['GetPostFormattedSchema'];
};
CSVDefaultDTO: {
/**
* @description User ID
* @example sdfdsfdsfEWEsdfsdsW32dd
*/
userId?: string;
};
CSVImportSchema: {
/**
* @description Csv Id
* @example ve9EPM428h8vShlRW1KT
*/
_id: string;
/**
* @description Account Ids
* @example [
* "aF3KhyL8JIuBwzK3m7Ly_iVrVJ2uoXNF0wzcBzgl5_12554616564525983496"
* ]
*/
accountIds?: string[];
/**
* @description Approver Id
* @example FSeSDsdfdf45Dgs4w3ssss
*/
approver?: string;
/**
* @description Posts count
* @example 5
*/
count?: number;
/**
* Format: date-time
* @description Date Created
* @example 2023-08-02T00:00:00.000Z
*/
createdAt?: string;
/**
* @description Created By Id
* @example SDsdfdf45Dgs4w3ssss
*/
createdBy?: string;
/**
* @description File path
* @example File
*/
file?: string;
/**
* @description File Name
* @example sample.csv
*/
fileName?: string;
/**
* @description locationId
* @example iVrVJ2uoXNF0wzcBzgl5
*/
locationId?: string;
/**
* @description Origin Id
* @example FSeSDsdfdf45Dgs4w3ssss
*/
originId?: string;
/**
* @description status must be one of the following values: pending, in_progress, completed, failed, in_review, importing, deleted
* @example completed
*/
status?: string;
/**
* @description Trace Id
* @example FSeSDsdfdf45Dgs4w3ssss
*/
traceId?: string;
};
CSVMediaResponseSchema: {
/**
* @description Media Aspect Ratio
* @example 1.5
*/
aspectRatio?: number;
/**
* @description Audio Channel
* @example 1
*/
audioChannels?: number;
/**
* @description Audio Codec
* @example aac
*/
audioCodecName?: string;
/**
* @description Display Aspect Ratio
* @example 250 : 167
*/
displayAspectRatio?: string;
/**
* @description Media Aspect Ratio
* @example 60
*/
duration?: number;
/**
* @description Error
* @example Image is larger than 10MB
*/
error?: string;
/**
* @description Facebook media error. It can be one of the following errors: imageSize, imageType, videoDuration, videoSize
* @example videoDuration
*/
facebookError?: string;
/**
* @description Media format
* @example jpg
*/
format?: string;
/**
* @description Video Frame Rate
* @example 21
*/
frameRate?: number;
/** @description List of frames */
frames?: string[];
/**
* @description GMB media error. It can be one of the following errors: imageSize, imageDimension, imageType
* @example imageDimension
*/
gmbError?: string;
/**
* @description Media Height
* @example 500
*/
height?: number;
/**
* @description Instagram media error. It can we one of the following errors: imageSize, imageType, imageAspectRatio, videoType, videoDuration, videoSize, videoAspectRatio, videoWidthHeight, audioCodec, audioCodecChannels, videoCodec, videoFrameRate
* @example imageSize
*/
instagramError?: string;
/**
* @description Media error. It can be one of the following values: imageSize, imageWidth
* @example imageSize
*/
invalidError?: string;
/**
* @description LinkedIn media error. It can be one of the following errors: imageSize, imageType, videoType, videoDuration, videoSize
* @example imageType
*/
linkedinError?: string;
/**
* @description Selected Poster
* @example 0
*/
selectedPoster?: number;
/**
* @description Media Size
* @example 18362
*/
size?: number;
/**
* @description Tikok Business media error. It can be one of the following errors: videoType, videoDuration, videoSize, videoWidthHeight, videoCodec, videoFrameRate
* @example videoType
*/
tiktokBusinessError?: string;
/**
* @description Tiktok media error. It can be one of the following errors: videoType, videoDuration, videoSize, videoWidthHeight, videoCodec, videoFrameRate
* @example videoFrameRate
*/
tiktokError?: string;
/**
* @description Twitter media error. It can be one of the following errors: imageSize, videoType, videoDuration, videoSize
* @example videoSize
*/
twitterError?: string;
/**
* @description Media Type
* @example image/webp
*/
type?: string;
/**
* @description Media Url
* @example https://storage.googleapis.com/ghl-test/omaDY3RbWtTP511e808O/media/38e53059-b92706571605.png
*/
url?: string;
/**
* @description Video Codec
* @example h264
*/
videoCodecName?: string;
/**
* @description Media Width
* @example 500
*/
width?: number;
};
CSVPostSchema: {
/**
* @description Account Ids
* @example [
* "aF3KhyL8JIuBwzK3m7Ly_iVrVJ2uoXNF0wzcBzgl5_12554616564525983496"
* ]
*/
accountIds?: string[];
/** @description Error Description */
errorMessage?: string;
/** @example Initial Comment */
followUpComment?: string;
/** @description GMB Post Details */
gmbPostDetails?: components['schemas']['GMBPostSchema'];
/** @description OG Tag */
link?: components['schemas']['IOgTagsSchema'];
/** @description Post Media List */
medias?: components['schemas']['CSVMediaResponseSchema'][];
/** @example 2022-11-23T05:53:00.000Z */
scheduleDate?: string;
/** @example First post */
summary?: string;
/** @description Tiktok Post Details */
tiktokPostDetails?: components['schemas']['TiktokPostSchema'];
/** @example post */
type?: Record<string, never>;
};
CsvPostStatusResponseDTO: {
/**
* @description Message
* @example Updated Successfully
*/
message: string;
/**
* @description Status Code
* @example 200
*/
statusCode: number;
/**
* @description Success or Failure
* @example true
*/
success: boolean;
};
CsvResponse: {
/**
* @description Account Ids
* @example [
* "aF3KhyL8JIuBwzK3m7Ly_iVrVJ2uoXNF0wzcBzgl5_12554616564525983496"
* ]
*/
accountIds?: string[];
/** @example FSeSDsdfdf45Dgs4w3ssss */
approver?: string;
/** @example 5 */
count?: number;
/** @example AccountId_SDsdfdf45Dgs4w3ssss */
createdBy?: string;
/** @example File */
file?: string;
/** @example File Name */
fileName?: string;
/** @example Location Name */
locationId?: string;
/** @example FSeSDsdfdf45Dgs4w3ssss */
originId?: string;
/**
* @description status must be one of the following values: pending, in_progress, completed, failed, in_review, importing, deleted
* @example completed
*/
status?: Record<string, never>;
/** @example FSeSDsdfdf45Dgs4w3ssss */
traceId?: string;
};
CSVResponseSchema: {
/** @description CSV Data */
csv?: components['schemas']['CsvResponse'];
};
DateSchema: {
/** @example 1 */
day: number;
/** @example 1 */
month: number;
/** @example 2022 */
year: number;
};
DeleteAccountResponseSchema: {
/**
* @description Id
* @example 65fac446d599990d1313c1dd
*/
id?: string;
/**
* @description Location Id
* @example ve9EPM428h8vShlRW1KT
*/
locationId?: string;
};
DeleteCsvResponseDTO: {
/**
* @description Message
* @example Deleted Post
*/
message: string;
/** @description Requested Results */
results?: components['schemas']['CSVResponseSchema'];
/**
* @description Status Code
* @example 200
*/
statusCode: number;
/**
* @description Success or Failure
* @example true
*/
success: boolean;
};
DeletePostResponseDTO: {
/**
* @description Message
* @example Deleted Post
*/
message: string;
/** @description Requested Results */
results?: components['schemas']['DeletePostResponseSchema'];
/**
* @description Status Code
* @example 200
*/
statusCode: number;
/**
* @description Success or Failure
* @example true
*/
success: boolean;
};
DeletePostResponseSchema: {
/** @description Post Id */
postId: string;
};
DeletePostsDto: {
/**
* @description Requested Results
* @example [
* "662791ee3f216822d7da0c8c"
* ]
*/
postIds?: string[];
};
DeletePostSuccessfulResponseDTO: {
/**
* @description Message
* @example Deleted Post
*/
message: string;
/** @description Requested Results */
results?: components['schemas']['DeletePostSuccessfulResponseSchema'];
/**
* @description Status Code
* @example 200
*/
statusCode: number;
/**
* @description Success or Failure
* @example true
*/
success: boolean;
};
DeletePostSuccessfulResponseSchema: {
postId?: string;
};
EndDateSchema: {
/** @description End Date */
endDate?: components['schemas']['DateSchema'];
/** @description End Time */
endTime?: components['schemas']['TimeSchema'];
};
FacebookPageSchema: {
/** @example u37swmmLbA02zgqKPpxITe2 */
avatar?: string;
/** @example u37swm