@pushwoosh/rpc-v2-http-api-data 0.2.246 → 0.2.247

package/approvals.d.ts

@@ -0,0 +1,80 @@
+import { RpcMethod } from './commonTypes';
+export type ApprovalsService_Submit = RpcMethod<SubmitApprovalRequest, SubmitApprovalResponse>;
+export type ApprovalsService_Approve = RpcMethod<ApproveRequest, ApproveResponse>;
+export type ApprovalsService_Reject = RpcMethod<RejectRequest, RejectResponse>;
+export type ApprovalsService_Cancel = RpcMethod<CancelApprovalRequest, CancelApprovalResponse>;
+export type ApprovalsService_List = RpcMethod<ListApprovalsRequest, ListApprovalsResponse>;
+export interface ApprovalsService {
+    /** Sends one content version of a push preset or email template for approval. The author submits, someone holding the ApproveMessages right decides; while the request is pending the version cannot be sent. */
+    Submit: ApprovalsService_Submit;
+    /** Approves a pending request, which makes exactly that content version sendable. Refused for the user who submitted it. */
+    Approve: ApprovalsService_Approve;
+    /** Rejects a pending request with a comment; the content stays unapproved and the author has to submit a new version. */
+    Reject: ApprovalsService_Reject;
+    /** Withdraws a pending request the caller submitted. */
+    Cancel: ApprovalsService_Cancel;
+    /** Lists approval requests of the account, newest first, optionally narrowed to one state or one content item. This is the approver inbox. */
+    List: ApprovalsService_List;
+}
+export type ApprovalState = 'APPROVAL_STATE_UNSPECIFIED' | 'APPROVAL_STATE_PENDING' | 'APPROVAL_STATE_APPROVED' | 'APPROVAL_STATE_REJECTED' | 'APPROVAL_STATE_CANCELLED';
+export type ContentOwnerType = 'CONTENT_OWNER_TYPE_UNSPECIFIED' | 'CONTENT_OWNER_TYPE_PUSH_PRESET' | 'CONTENT_OWNER_TYPE_EMAIL_TEMPLATE';
+export type ApprovalRequest = {
+    id: number;
+    application: string;
+    ownerType: ContentOwnerType;
+    /** Code of the content item the version belongs to. */
+    ownerCode: string;
+    contentVersionId: number;
+    /** Sequential number of that version within the content item. */
+    versionNo: number;
+    state: ApprovalState;
+    requestedBy: number;
+    decidedBy: number;
+    decidedAt: Date;
+    comment: string;
+    created: Date;
+};
+export type SubmitApprovalRequest = {
+    ownerType?: ContentOwnerType;
+    /** Code of the push preset or email template to send for approval. */
+    ownerCode?: string;
+};
+export type SubmitApprovalResponse = {
+    approval: ApprovalRequest;
+};
+export type ApproveRequest = {
+    id?: number;
+    /** Optional note for the author. */
+    comment?: string;
+};
+export type ApproveResponse = {
+    approval: ApprovalRequest;
+};
+export type RejectRequest = {
+    id?: number;
+    /** Why it was rejected; shown to the author. */
+    comment?: string;
+};
+export type RejectResponse = {
+    approval: ApprovalRequest;
+};
+export type CancelApprovalRequest = {
+    id?: number;
+};
+export type CancelApprovalResponse = {};
+export type ListApprovalsRequest = {
+    /** Application code to narrow the list to; omit for the whole account. */
+    application?: string;
+    /** Keeps only requests in this state; omit for all states. */
+    state?: ApprovalState;
+    /** Keeps only requests for this content item. */
+    ownerCode?: string;
+    page?: number;
+    perPage?: number;
+};
+export type ListApprovalsResponse = {
+    approvals: ApprovalRequest[];
+    page: number;
+    perPage: number;
+    total: number;
+};

package/approvals.js

@@ -0,0 +1,3 @@
+/* eslint-disable */
+/* Autogenerated code */
+export {};

package/data.js

@@ -7508,6 +7508,208 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.approvals.ApprovalsService": {
+        "type": "S",
+        "key": "approvals",
+        "methods": {
+            "Submit": {
+                "request": "pushwoosh.rpc_v2.approvals.SubmitApprovalRequest",
+                "response": "pushwoosh.rpc_v2.approvals.SubmitApprovalResponse",
+                "method": "post",
+                "path": "/api/approvals"
+            },
+            "Approve": {
+                "request": "pushwoosh.rpc_v2.approvals.ApproveRequest",
+                "response": "pushwoosh.rpc_v2.approvals.ApproveResponse",
+                "method": "post",
+                "path": "/api/approvals/{id}/approve"
+            },
+            "Reject": {
+                "request": "pushwoosh.rpc_v2.approvals.RejectRequest",
+                "response": "pushwoosh.rpc_v2.approvals.RejectResponse",
+                "method": "post",
+                "path": "/api/approvals/{id}/reject"
+            },
+            "Cancel": {
+                "request": "pushwoosh.rpc_v2.approvals.CancelApprovalRequest",
+                "response": "pushwoosh.rpc_v2.approvals.CancelApprovalResponse",
+                "method": "post",
+                "path": "/api/approvals/{id}/cancel"
+            },
+            "List": {
+                "request": "pushwoosh.rpc_v2.approvals.ListApprovalsRequest",
+                "response": "pushwoosh.rpc_v2.approvals.ListApprovalsResponse",
+                "method": "get",
+                "path": "/api/approvals"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.approvals.ApprovalState": {
+        "type": "E",
+        "values": [
+            "APPROVAL_STATE_UNSPECIFIED",
+            "APPROVAL_STATE_PENDING",
+            "APPROVAL_STATE_APPROVED",
+            "APPROVAL_STATE_REJECTED",
+            "APPROVAL_STATE_CANCELLED"
+        ]
+    },
+    "pushwoosh.rpc_v2.approvals.ContentOwnerType": {
+        "type": "E",
+        "values": [
+            "CONTENT_OWNER_TYPE_UNSPECIFIED",
+            "CONTENT_OWNER_TYPE_PUSH_PRESET",
+            "CONTENT_OWNER_TYPE_EMAIL_TEMPLATE"
+        ]
+    },
+    "pushwoosh.rpc_v2.approvals.ApprovalRequest": {
+        "type": "I",
+        "fields": {
+            "id": {
+                "type": "number"
+            },
+            "application": {
+                "type": "string"
+            },
+            "ownerType": {
+                "type": "pushwoosh.rpc_v2.approvals.ContentOwnerType"
+            },
+            "ownerCode": {
+                "type": "string"
+            },
+            "contentVersionId": {
+                "type": "number"
+            },
+            "versionNo": {
+                "type": "number"
+            },
+            "state": {
+                "type": "pushwoosh.rpc_v2.approvals.ApprovalState"
+            },
+            "requestedBy": {
+                "type": "number"
+            },
+            "decidedBy": {
+                "type": "number"
+            },
+            "decidedAt": {
+                "type": "Date"
+            },
+            "comment": {
+                "type": "string"
+            },
+            "created": {
+                "type": "Date"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.approvals.SubmitApprovalRequest": {
+        "type": "I",
+        "fields": {
+            "ownerType": {
+                "type": "pushwoosh.rpc_v2.approvals.ContentOwnerType"
+            },
+            "ownerCode": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.approvals.SubmitApprovalResponse": {
+        "type": "I",
+        "fields": {
+            "approval": {
+                "type": "pushwoosh.rpc_v2.approvals.ApprovalRequest"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.approvals.ApproveRequest": {
+        "type": "I",
+        "fields": {
+            "id": {
+                "type": "number"
+            },
+            "comment": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.approvals.ApproveResponse": {
+        "type": "I",
+        "fields": {
+            "approval": {
+                "type": "pushwoosh.rpc_v2.approvals.ApprovalRequest"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.approvals.RejectRequest": {
+        "type": "I",
+        "fields": {
+            "id": {
+                "type": "number"
+            },
+            "comment": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.approvals.RejectResponse": {
+        "type": "I",
+        "fields": {
+            "approval": {
+                "type": "pushwoosh.rpc_v2.approvals.ApprovalRequest"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.approvals.CancelApprovalRequest": {
+        "type": "I",
+        "fields": {
+            "id": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.approvals.CancelApprovalResponse": {
+        "type": "I",
+        "fields": {}
+    },
+    "pushwoosh.rpc_v2.approvals.ListApprovalsRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "state": {
+                "type": "pushwoosh.rpc_v2.approvals.ApprovalState"
+            },
+            "ownerCode": {
+                "type": "string"
+            },
+            "page": {
+                "type": "number"
+            },
+            "perPage": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.approvals.ListApprovalsResponse": {
+        "type": "I",
+        "fields": {
+            "approvals": {
+                "type": "pushwoosh.rpc_v2.approvals.ApprovalRequest",
+                "array": true
+            },
+            "page": {
+                "type": "number"
+            },
+            "perPage": {
+                "type": "number"
+            },
+            "total": {
+                "type": "number"
+            }
+        }
+    },
     "pushwoosh.rpc_v2.campaigns.CampaignsService": {
         "type": "S",
         "key": "campaigns",

package/index.d.ts

@@ -16,6 +16,7 @@ import { ApplicationsControlGroupService as pushwoosh_rpc_v2_applications_contro
 import { ApplicationsGroupsService as pushwoosh_rpc_v2_applications_groups_ApplicationsGroupsService } from './applications_groups';
 import { ApplicationsInfoService as pushwoosh_rpc_v2_applications_info_ApplicationsInfoService } from './applications_info';
 import { ApplicationsStatisticsService as pushwoosh_rpc_v2_applications_statistics_ApplicationsStatisticsService } from './applications_statistics';
+import { ApprovalsService as pushwoosh_rpc_v2_approvals_ApprovalsService } from './approvals';
 import { CampaignsService as pushwoosh_rpc_v2_campaigns_CampaignsService } from './campaigns';
 import { CatalogService as pushwoosh_rpc_v2_catalog_CatalogService } from './catalog';
 import { CategoriesService as pushwoosh_rpc_v2_categories_CategoriesService } from './categories';
@@ -87,6 +88,7 @@ export type API = {
     applicationsGroups: pushwoosh_rpc_v2_applications_groups_ApplicationsGroupsService;
     applicationsInfo: pushwoosh_rpc_v2_applications_info_ApplicationsInfoService;
     applicationsStatistics: pushwoosh_rpc_v2_applications_statistics_ApplicationsStatisticsService;
+    approvals: pushwoosh_rpc_v2_approvals_ApprovalsService;
     campaigns: pushwoosh_rpc_v2_campaigns_CampaignsService;
     catalog: pushwoosh_rpc_v2_catalog_CatalogService;
     categories: pushwoosh_rpc_v2_categories_CategoriesService;

package/package.json

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