@compassdigital/sdk.typescript 3.3.0 → 3.5.0

package/src/interface/permission.ts

@@ -0,0 +1,233 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface Success {
+  success?: boolean;
+}
+
+export interface Error {
+  message?: string;
+  code?: number;
+}
+
+export interface PermissionBody {
+  recipient_id?: string;
+  // The organization or domain to which this role belongs
+  domain: string;
+  // The object type we give permission to
+  object: string;
+  // The action we allow to happen.
+  action: string;
+  // The relationship link to the resource. If not passed *:RECIPIENT_USER_ID is used
+  link?: string;
+  // Properties that are allowed in permission. If not allowed should be prefixed with !.
+  properties?: string;
+}
+
+export interface Permission {
+  // permission
+  id?: string;
+  recipient_id?: string;
+  // The organization or domain to which this role belongs
+  domain: string;
+  // The object type we give permission to
+  object: string;
+  // The action we allow to happen.
+  action: string;
+  // The relationship link to the resource
+  link?: string;
+  // Properties that are allowed in permission. If not allowed should be prefixed with !.
+  properties?: string;
+  last_updated_by?: string;
+  date_created?: string;
+  date_modified?: string;
+}
+
+export interface Permissions {
+  permissions: Permission[];
+}
+
+export interface Role {
+  // role
+  id: string;
+  // Role Name
+  name: string;
+  // The status of whether the role is in use or not
+  status: string;
+  // The organization or domain to which this role belongs
+  domain: string;
+  // The description of the role
+  description?: string;
+  last_updated_by?: string;
+  date_created?: string;
+  date_modified?: string;
+}
+
+export interface RoleBody {
+  // Role Name
+  name: string;
+  // The status of whether the role is in use or not
+  status?: string;
+  // The organization or domain to which this role belongs
+  domain: string;
+  // The description of the role
+  description?: string;
+}
+
+export interface RolePatchBody {
+  // Role Name
+  name?: string;
+  // The status of whether the role is in use or not
+  status?: string;
+  // The description of the role
+  description?: string;
+}
+
+export interface RoleAssignmentBody {
+  // role
+  role_id: string;
+  recipient_id: string;
+  meta?: any;
+}
+
+export interface RoleAssignment {
+  // role_assignment
+  id: string;
+  // role
+  role_id: string;
+  recipient_id: string;
+  meta?: any;
+  last_updated_by?: string;
+  date_created?: string;
+  date_modified?: string;
+}
+
+export interface RoleAssignments {
+  role_assignments: RoleAssignment[];
+}
+
+export interface Roles {
+  roles: Role[];
+  last_key?: string;
+}
+
+// POST /permission - Creates a new permission for a role or a user
+
+export type PostPermissionBody = PermissionBody;
+
+export type PostPermissionResponse = Permission;
+
+export interface PostPermissionRequest {
+  body: PostPermissionBody;
+}
+
+// DELETE /permission/{id} - Delete a permission from a role or a user
+
+export interface DeletePermissionPath {
+  // permission
+  id: string;
+}
+
+export type DeletePermissionResponse = Success;
+
+export interface DeletePermissionRequest extends DeletePermissionPath {}
+
+// GET /permission/role - Get Roles, with pagination and filters
+
+export interface GetPermissionRoleQuery {
+  // Filter roles by their domain
+  domain: string;
+  // Filter roles by their status.
+  status?: string;
+  // Key for pagination, retrieves the next page of items
+  start_at?: string;
+}
+
+export type GetPermissionRoleResponse = Roles;
+
+export interface GetPermissionRoleRequest extends GetPermissionRoleQuery {}
+
+// POST /permission/role - Create a new role
+
+export type PostPermissionRoleBody = RoleBody;
+
+export type PostPermissionRoleResponse = Role;
+
+export interface PostPermissionRoleRequest {
+  body: PostPermissionRoleBody;
+}
+
+// PATCH /permission/role/{id} - Update a role
+
+export interface PatchPermissionRolePath {
+  // role
+  id: string;
+}
+
+export type PatchPermissionRoleBody = RolePatchBody;
+
+export type PatchPermissionRoleResponse = Role;
+
+export interface PatchPermissionRoleRequest extends PatchPermissionRolePath {
+  body: PatchPermissionRoleBody;
+}
+
+// GET /permission/recipient/{recipient_id} - Get permissions for a recipient(role or user id)
+
+export interface GetPermissionRecipientPath {
+  // CDL Id of a recipient
+  recipient: string;
+  // TODO: add parameter to swagger.json
+  recipient_id: string;
+}
+
+export interface GetPermissionRecipientQuery {
+  // Show additional meta fields
+  extended?: boolean;
+}
+
+export type GetPermissionRecipientResponse = Permissions;
+
+export interface GetPermissionRecipientRequest
+  extends GetPermissionRecipientQuery,
+    GetPermissionRecipientPath {}
+
+// GET /permission/role/user/{user_id} - Get a list of role assignments for a user
+
+export interface GetPermissionRoleUserPath {
+  // Id of a user
+  user_id: string;
+}
+
+export type GetPermissionRoleUserResponse = RoleAssignments;
+
+export interface GetPermissionRoleUserRequest extends GetPermissionRoleUserPath {}
+
+// POST /permission/role/user/{user_id} - Assign a role to a user
+
+export interface PostPermissionRoleUserPath {
+  // Id of a user
+  user_id: string;
+}
+
+export type PostPermissionRoleUserBody = RoleAssignmentBody;
+
+export type PostPermissionRoleUserResponse = RoleAssignment;
+
+export interface PostPermissionRoleUserRequest extends PostPermissionRoleUserPath {
+  body: PostPermissionRoleUserBody;
+}
+
+// DELETE /permission/role/user/{user_id} - Remove a role from a user
+
+export interface DeletePermissionRoleUserPath {
+  // Id of a user
+  user_id: string;
+}
+
+export type DeletePermissionRoleUserBody = RoleAssignment;
+
+export type DeletePermissionRoleUserResponse = Success;
+
+export interface DeletePermissionRoleUserRequest extends DeletePermissionRoleUserPath {
+  body: DeletePermissionRoleUserBody;
+}

package/src/interface/sms.ts

@@ -0,0 +1 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY

package/src/interface/vendor.ts

@@ -0,0 +1,244 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface Error {
+  message?: string;
+  code?: number;
+}
+
+export interface Vendor {
+  // vendor
+  id?: string;
+  name?: string;
+  description?: string;
+  email?: string;
+  phone?: string;
+  // Property to store any additional data
+  meta?: {
+    legacy_token?: {
+      dev?: string;
+      staging?: string;
+      v1?: string;
+    };
+  };
+  domain?: string;
+}
+
+export interface VendorPostBody {
+  name: string;
+  description?: string;
+  email: string;
+  domain?: string;
+  phone?: string;
+}
+
+export interface Vendors {
+  vendors: Vendor[];
+}
+
+export interface Key {
+  // key
+  id: string;
+  date_created?: string;
+  date_modified?: string;
+  // Unique client id for this key. Will remain same on rotation
+  client_id?: string;
+  // Unique password for this key.
+  client_password?: string;
+  // Date the key becomes expired
+  date_expires?: string;
+  environment?: string;
+  permissions?: string[];
+  // Flag identifying if the key is latest
+  active?: boolean;
+  domain?: string;
+}
+
+export interface KeyPostBody {
+  // vendor
+  vendor_id: string;
+  // Date the key becomes expired
+  date_expires: string;
+  environment: string;
+  permissions: string[];
+}
+
+export interface KeyPatchBody {
+  // Date the key becomes expired
+  date_expires?: string;
+  permissions?: string[];
+}
+
+export interface Keys {
+  keys: Key[];
+}
+
+export interface Success {
+  success?: boolean;
+}
+
+export interface Auth {
+  access: {
+    token?: string;
+    expires?: string;
+  };
+  refresh: {
+    token?: string;
+    expires?: string;
+  };
+}
+
+export interface RefreshPayload {
+  access_token: string;
+  refresh_token: string;
+}
+
+// POST /vendor - Create new vendor
+
+export type PostVendorBody = VendorPostBody;
+
+export type PostVendorResponse = Vendor;
+
+export interface PostVendorRequest {
+  body: PostVendorBody;
+}
+
+// GET /vendor - Get all Vendors
+
+export type GetVendorsResponse = Vendors;
+
+export type GetVendorsRequest = {};
+
+// GET /vendor/{id} - Get info about the Vendor
+
+export interface GetVendorPath {
+  // vendor
+  id: string;
+}
+
+export type GetVendorResponse = Vendor;
+
+export interface GetVendorRequest extends GetVendorPath {}
+
+// PATCH /vendor/{id} - Update info about the Vendor
+
+export interface PatchVendorPath {
+  // vendor
+  id: string;
+}
+
+export type PatchVendorBody = Vendor;
+
+export type PatchVendorResponse = Vendor;
+
+export interface PatchVendorRequest extends PatchVendorPath {
+  body: PatchVendorBody;
+}
+
+// GET /vendor/auth - Get access/refresh tokens for accessing our APIs
+
+export type GetVendorAuthResponse = Auth;
+
+export type GetVendorAuthRequest = {};
+
+// POST /vendor/auth - Get new access token using refresh token and previous token
+
+export type PostVendorAuthBody = RefreshPayload;
+
+export type PostVendorAuthResponse = Auth;
+
+export interface PostVendorAuthRequest {
+  body: PostVendorAuthBody;
+}
+
+// GET /vendor/{id}/key - Get list of Vendor keys
+
+export interface GetVendorKeysPath {
+  // vendor
+  id: string;
+}
+
+export type GetVendorKeysResponse = Keys;
+
+export interface GetVendorKeysRequest extends GetVendorKeysPath {}
+
+// POST /vendor/{id}/key - Create new key for the vendor
+
+export interface PostVendorKeyPath {
+  // vendor
+  id: string;
+}
+
+export type PostVendorKeyBody = KeyPostBody;
+
+export type PostVendorKeyResponse = Key;
+
+export interface PostVendorKeyRequest extends PostVendorKeyPath {
+  body: PostVendorKeyBody;
+}
+
+// GET /vendor/{id}/key/{key} - Get info about vendor key
+
+export interface GetVendorKeyPath {
+  // vendor
+  id: string;
+  // key
+  key: string;
+}
+
+export interface GetVendorKeyQuery {
+  // Pagination token to start query from
+  last_evaluated_key?: string;
+}
+
+export type GetVendorKeyResponse = Key;
+
+export interface GetVendorKeyRequest extends GetVendorKeyQuery, GetVendorKeyPath {}
+
+// PATCH /vendor/{id}/key/{key} - Update info for vendor key
+
+export interface PatchVendorKeyPath {
+  // vendor
+  id: string;
+  // key
+  key: string;
+}
+
+export type PatchVendorKeyBody = KeyPatchBody;
+
+export type PatchVendorKeyResponse = Key;
+
+export interface PatchVendorKeyRequest extends PatchVendorKeyPath {
+  body: PatchVendorKeyBody;
+}
+
+// DELETE /vendor/{id}/key/{key} - Mark key as expired
+
+export interface DeleteVendorKeyPath {
+  // vendor
+  id: string;
+  // key
+  key: string;
+}
+
+export type DeleteVendorKeyResponse = Key;
+
+export interface DeleteVendorKeyRequest extends DeleteVendorKeyPath {}
+
+// POST /vendor/{id}/key/{key}/rotate - Rotate vendor key
+
+export interface PostVendorKeyRotatePath {
+  // vendor
+  id: string;
+  // key
+  key: string;
+}
+
+export interface PostVendorKeyRotateQuery {
+  date_expires?: string;
+}
+
+export type PostVendorKeyRotateResponse = Success;
+
+export interface PostVendorKeyRotateRequest
+  extends PostVendorKeyRotateQuery,
+    PostVendorKeyRotatePath {}