@pushwoosh/rpc-v2-http-api-data 0.2.387 → 0.2.389
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/canva.d.ts +41 -0
- package/data.js +78 -0
- package/package.json +1 -1
package/canva.d.ts
CHANGED
|
@@ -4,6 +4,8 @@ export type CanvaService_GetStatus = RpcMethod<GetCanvaStatusRequest, GetCanvaSt
|
|
|
4
4
|
export type CanvaService_ListDesigns = RpcMethod<ListCanvaDesignsRequest, ListCanvaDesignsResponse>;
|
|
5
5
|
export type CanvaService_StartImport = RpcMethod<StartCanvaImportRequest, StartCanvaImportResponse>;
|
|
6
6
|
export type CanvaService_GetImport = RpcMethod<GetCanvaImportRequest, GetCanvaImportResponse>;
|
|
7
|
+
export type CanvaService_StartEdit = RpcMethod<StartCanvaEditRequest, StartCanvaEditResponse>;
|
|
8
|
+
export type CanvaService_CompleteEdit = RpcMethod<CompleteCanvaEditRequest, CompleteCanvaEditResponse>;
|
|
7
9
|
/**
|
|
8
10
|
* CanvaService reads the calling user's own Canva designs for the Media Library import. The user
|
|
9
11
|
* connects Canva once through the OAuth integration endpoints with provider "canva".
|
|
@@ -17,6 +19,10 @@ export interface CanvaService {
|
|
|
17
19
|
StartImport: CanvaService_StartImport;
|
|
18
20
|
/** 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). */
|
|
19
21
|
GetImport: CanvaService_GetImport;
|
|
22
|
+
/** Opens a Media Library image, or a new blank design of the given size, in the user's Canva editor and returns the editor link. Canva sends the user back to return_url when they are done; complete_canva_edit then stores the result. The link works only for this user in a browser. */
|
|
23
|
+
StartEdit: CanvaService_StartEdit;
|
|
24
|
+
/** Stores the design the user brought back from Canva: a new version of the edited image, or a new image for a new design. Takes the canva_return token from the return link once; poll get_canva_import with the returned id. */
|
|
25
|
+
CompleteEdit: CanvaService_CompleteEdit;
|
|
20
26
|
}
|
|
21
27
|
export type CanvaImportFormat = 'CANVA_IMPORT_FORMAT_UNSPECIFIED' | 'CANVA_IMPORT_FORMAT_PNG' | 'CANVA_IMPORT_FORMAT_JPG';
|
|
22
28
|
export type CanvaImportState = 'CANVA_IMPORT_STATE_UNSPECIFIED'
|
|
@@ -80,3 +86,38 @@ export type ListCanvaDesignsResponse = {
|
|
|
80
86
|
/** Token for the next page; empty on the last one. */
|
|
81
87
|
continuation: string;
|
|
82
88
|
};
|
|
89
|
+
export type CanvaDesignSize = {
|
|
90
|
+
/** Pixels, 40 to 8000. */
|
|
91
|
+
width: number;
|
|
92
|
+
height: number;
|
|
93
|
+
};
|
|
94
|
+
export type StartCanvaEditRequest_target_mediaUuid = {
|
|
95
|
+
type: 'mediaUuid';
|
|
96
|
+
data: string;
|
|
97
|
+
};
|
|
98
|
+
export type StartCanvaEditRequest_target_size = {
|
|
99
|
+
type: 'size';
|
|
100
|
+
data: CanvaDesignSize;
|
|
101
|
+
};
|
|
102
|
+
export type StartCanvaEditRequest_target = StartCanvaEditRequest_target_mediaUuid | StartCanvaEditRequest_target_size;
|
|
103
|
+
export type StartCanvaEditRequest = {
|
|
104
|
+
/** Application code (format XXXXX-XXXXX) whose Media Library holds the image or receives the new one. */
|
|
105
|
+
application?: string;
|
|
106
|
+
/** Control panel page Canva returns the user to, on an allowed host; it receives a canva_return query parameter. */
|
|
107
|
+
returnUrl?: string;
|
|
108
|
+
/** Title of a new design; the image's file name when empty. */
|
|
109
|
+
title?: string;
|
|
110
|
+
target: StartCanvaEditRequest_target;
|
|
111
|
+
};
|
|
112
|
+
export type StartCanvaEditResponse = {
|
|
113
|
+
editUrl: string;
|
|
114
|
+
/** True when the image was copied into a new design because its Canva original is not the user's. */
|
|
115
|
+
copied: boolean;
|
|
116
|
+
};
|
|
117
|
+
export type CompleteCanvaEditRequest = {
|
|
118
|
+
/** The canva_return value from the return link. */
|
|
119
|
+
correlationJwt?: string;
|
|
120
|
+
};
|
|
121
|
+
export type CompleteCanvaEditResponse = {
|
|
122
|
+
importId: string;
|
|
123
|
+
};
|
package/data.js
CHANGED
|
@@ -8777,6 +8777,18 @@ export const data = {
|
|
|
8777
8777
|
"response": "pushwoosh.rpc_v2.canva.GetCanvaImportResponse",
|
|
8778
8778
|
"method": "get",
|
|
8779
8779
|
"path": "/api/canva/imports/{import_id}"
|
|
8780
|
+
},
|
|
8781
|
+
"StartEdit": {
|
|
8782
|
+
"request": "pushwoosh.rpc_v2.canva.StartCanvaEditRequest",
|
|
8783
|
+
"response": "pushwoosh.rpc_v2.canva.StartCanvaEditResponse",
|
|
8784
|
+
"method": "post",
|
|
8785
|
+
"path": "/api/canva/edits"
|
|
8786
|
+
},
|
|
8787
|
+
"CompleteEdit": {
|
|
8788
|
+
"request": "pushwoosh.rpc_v2.canva.CompleteCanvaEditRequest",
|
|
8789
|
+
"response": "pushwoosh.rpc_v2.canva.CompleteCanvaEditResponse",
|
|
8790
|
+
"method": "post",
|
|
8791
|
+
"path": "/api/canva/edits:complete"
|
|
8780
8792
|
}
|
|
8781
8793
|
}
|
|
8782
8794
|
},
|
|
@@ -8923,6 +8935,72 @@ export const data = {
|
|
|
8923
8935
|
}
|
|
8924
8936
|
}
|
|
8925
8937
|
},
|
|
8938
|
+
"pushwoosh.rpc_v2.canva.CanvaDesignSize": {
|
|
8939
|
+
"type": "I",
|
|
8940
|
+
"fields": {
|
|
8941
|
+
"width": {
|
|
8942
|
+
"type": "number"
|
|
8943
|
+
},
|
|
8944
|
+
"height": {
|
|
8945
|
+
"type": "number"
|
|
8946
|
+
}
|
|
8947
|
+
}
|
|
8948
|
+
},
|
|
8949
|
+
"pushwoosh.rpc_v2.canva.StartCanvaEditRequest": {
|
|
8950
|
+
"type": "I",
|
|
8951
|
+
"fields": {
|
|
8952
|
+
"application": {
|
|
8953
|
+
"type": "string"
|
|
8954
|
+
},
|
|
8955
|
+
"mediaUuid": {
|
|
8956
|
+
"type": "string"
|
|
8957
|
+
},
|
|
8958
|
+
"size": {
|
|
8959
|
+
"type": "pushwoosh.rpc_v2.canva.CanvaDesignSize"
|
|
8960
|
+
},
|
|
8961
|
+
"returnUrl": {
|
|
8962
|
+
"type": "string"
|
|
8963
|
+
},
|
|
8964
|
+
"title": {
|
|
8965
|
+
"type": "string"
|
|
8966
|
+
}
|
|
8967
|
+
},
|
|
8968
|
+
"oneofs": {
|
|
8969
|
+
"target": {
|
|
8970
|
+
"oneof": [
|
|
8971
|
+
"mediaUuid",
|
|
8972
|
+
"size"
|
|
8973
|
+
]
|
|
8974
|
+
}
|
|
8975
|
+
}
|
|
8976
|
+
},
|
|
8977
|
+
"pushwoosh.rpc_v2.canva.StartCanvaEditResponse": {
|
|
8978
|
+
"type": "I",
|
|
8979
|
+
"fields": {
|
|
8980
|
+
"editUrl": {
|
|
8981
|
+
"type": "string"
|
|
8982
|
+
},
|
|
8983
|
+
"copied": {
|
|
8984
|
+
"type": "boolean"
|
|
8985
|
+
}
|
|
8986
|
+
}
|
|
8987
|
+
},
|
|
8988
|
+
"pushwoosh.rpc_v2.canva.CompleteCanvaEditRequest": {
|
|
8989
|
+
"type": "I",
|
|
8990
|
+
"fields": {
|
|
8991
|
+
"correlationJwt": {
|
|
8992
|
+
"type": "string"
|
|
8993
|
+
}
|
|
8994
|
+
}
|
|
8995
|
+
},
|
|
8996
|
+
"pushwoosh.rpc_v2.canva.CompleteCanvaEditResponse": {
|
|
8997
|
+
"type": "I",
|
|
8998
|
+
"fields": {
|
|
8999
|
+
"importId": {
|
|
9000
|
+
"type": "string"
|
|
9001
|
+
}
|
|
9002
|
+
}
|
|
9003
|
+
},
|
|
8926
9004
|
"pushwoosh.rpc_v2.catalog.CatalogService": {
|
|
8927
9005
|
"type": "S",
|
|
8928
9006
|
"key": "catalog",
|