@pushwoosh/rpc-v2-http-api-data 0.2.382 → 0.2.385

package/canva.d.ts

@@ -1,13 +1,63 @@
 import { RpcMethod } from './commonTypes';
+import { MediaFile as pushwoosh_rpc_v2_media_files_MediaFile } from './media_files';
+export type CanvaService_GetStatus = RpcMethod<GetCanvaStatusRequest, GetCanvaStatusResponse>;
 export type CanvaService_ListDesigns = RpcMethod<ListCanvaDesignsRequest, ListCanvaDesignsResponse>;
+export type CanvaService_StartImport = RpcMethod<StartCanvaImportRequest, StartCanvaImportResponse>;
+export type CanvaService_GetImport = RpcMethod<GetCanvaImportRequest, GetCanvaImportResponse>;
 /**
  * CanvaService reads the calling user's own Canva designs for the Media Library import. The user
  * connects Canva once through the OAuth integration endpoints with provider "canva".
  */
 export interface CanvaService {
+    /** Tells whether Canva import is available to the calling user and whether that user has connected Canva, without calling Canva. Use to decide whether to show the import entry point and the connect step. */
+    GetStatus: CanvaService_GetStatus;
     /** Lists the calling user's Canva designs, newest edited first, optionally filtered by a title search; pass continuation from the previous page to read the next. Needs that user's own Canva connection and a signed-in user: API tokens are refused, because a Canva grant opens one person's designs. */
     ListDesigns: CanvaService_ListDesigns;
+    /** Starts importing pages of the user's Canva design into an application's Media Library as images. Spends one Canva export of the integration's shared daily quota; poll get_canva_import with the returned id until it is done or failed. */
+    StartImport: CanvaService_StartImport;
+    /** Advances and reports a Canva import: waits for the export, then stores the pages in the Media Library a few per call. Poll until state is done (files hold the stored images) or failed (error says why). */
+    GetImport: CanvaService_GetImport;
 }
+export type CanvaImportFormat = 'CANVA_IMPORT_FORMAT_UNSPECIFIED' | 'CANVA_IMPORT_FORMAT_PNG' | 'CANVA_IMPORT_FORMAT_JPG';
+export type CanvaImportState = 'CANVA_IMPORT_STATE_UNSPECIFIED'
+/** Canva is rendering the export. */
+ | 'CANVA_IMPORT_STATE_EXPORTING'
+/** The pages are being stored in the Media Library. */
+ | 'CANVA_IMPORT_STATE_UPLOADING' | 'CANVA_IMPORT_STATE_DONE' | 'CANVA_IMPORT_STATE_FAILED';
+export type StartCanvaImportRequest = {
+    /** Application code (format XXXXX-XXXXX) whose Media Library receives the images. */
+    application?: string;
+    designId?: string;
+    /** 1-based page numbers, at most 10; empty imports page 1. */
+    pages?: number[];
+    /** PNG when unset. */
+    format?: CanvaImportFormat;
+};
+export type StartCanvaImportResponse = {
+    importId: string;
+};
+export type GetCanvaImportRequest = {
+    importId?: string;
+};
+export type GetCanvaImportResponse = {
+    state: CanvaImportState;
+    pagesTotal: number;
+    pagesDone: number;
+    /** Stored images in page order, filled as pages land. */
+    files: pushwoosh_rpc_v2_media_files_MediaFile[];
+    /** Why the import failed, readable by the user; empty otherwise. */
+    error: string;
+};
+export type GetCanvaStatusRequest = {};
+export type GetCanvaStatusResponse = {
+    /** False when Canva is off in this region, the account is not in the beta, or the caller is not a signed-in user. */
+    available: boolean;
+    connected: boolean;
+    /** The Canva display name of the connection. */
+    identity: string;
+    /** False when Canva rejected the stored grant: connect again. */
+    tokenValid: boolean;
+};
 export type ListCanvaDesignsRequest = {
     /** Title search; empty lists every design the user can access. */
     query?: string;

package/data.js

@@ -8750,11 +8750,123 @@ export const data = {
         "type": "S",
         "key": "canva",
         "methods": {
+            "GetStatus": {
+                "request": "pushwoosh.rpc_v2.canva.GetCanvaStatusRequest",
+                "response": "pushwoosh.rpc_v2.canva.GetCanvaStatusResponse",
+                "method": "get",
+                "path": "/api/canva/status"
+            },
             "ListDesigns": {
                 "request": "pushwoosh.rpc_v2.canva.ListCanvaDesignsRequest",
                 "response": "pushwoosh.rpc_v2.canva.ListCanvaDesignsResponse",
                 "method": "get",
                 "path": "/api/canva/designs"
+            },
+            "StartImport": {
+                "request": "pushwoosh.rpc_v2.canva.StartCanvaImportRequest",
+                "response": "pushwoosh.rpc_v2.canva.StartCanvaImportResponse",
+                "method": "post",
+                "path": "/api/canva/imports"
+            },
+            "GetImport": {
+                "request": "pushwoosh.rpc_v2.canva.GetCanvaImportRequest",
+                "response": "pushwoosh.rpc_v2.canva.GetCanvaImportResponse",
+                "method": "get",
+                "path": "/api/canva/imports/{import_id}"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.canva.CanvaImportFormat": {
+        "type": "E",
+        "values": [
+            "CANVA_IMPORT_FORMAT_UNSPECIFIED",
+            "CANVA_IMPORT_FORMAT_PNG",
+            "CANVA_IMPORT_FORMAT_JPG"
+        ]
+    },
+    "pushwoosh.rpc_v2.canva.CanvaImportState": {
+        "type": "E",
+        "values": [
+            "CANVA_IMPORT_STATE_UNSPECIFIED",
+            "CANVA_IMPORT_STATE_EXPORTING",
+            "CANVA_IMPORT_STATE_UPLOADING",
+            "CANVA_IMPORT_STATE_DONE",
+            "CANVA_IMPORT_STATE_FAILED"
+        ]
+    },
+    "pushwoosh.rpc_v2.canva.StartCanvaImportRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "designId": {
+                "type": "string"
+            },
+            "pages": {
+                "type": "number",
+                "array": true
+            },
+            "format": {
+                "type": "pushwoosh.rpc_v2.canva.CanvaImportFormat"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.canva.StartCanvaImportResponse": {
+        "type": "I",
+        "fields": {
+            "importId": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.canva.GetCanvaImportRequest": {
+        "type": "I",
+        "fields": {
+            "importId": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.canva.GetCanvaImportResponse": {
+        "type": "I",
+        "fields": {
+            "state": {
+                "type": "pushwoosh.rpc_v2.canva.CanvaImportState"
+            },
+            "pagesTotal": {
+                "type": "number"
+            },
+            "pagesDone": {
+                "type": "number"
+            },
+            "files": {
+                "type": "pushwoosh.rpc_v2.media_files.MediaFile",
+                "array": true
+            },
+            "error": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.canva.GetCanvaStatusRequest": {
+        "type": "I",
+        "fields": {}
+    },
+    "pushwoosh.rpc_v2.canva.GetCanvaStatusResponse": {
+        "type": "I",
+        "fields": {
+            "available": {
+                "type": "boolean"
+            },
+            "connected": {
+                "type": "boolean"
+            },
+            "identity": {
+                "type": "string"
+            },
+            "tokenValid": {
+                "type": "boolean"
             }
         }
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushwoosh/rpc-v2-http-api-data",
-  "version": "0.2.382",
+  "version": "0.2.385",
   "description": "RPC V2 HTTP API Types and Data",
   "main": "index.js",
   "module": "index.js",