Platform API ClientClient group4 methodsApprovalsMethods

approvals

Reference methods for approvals.

Approvals

approvals.list()

Generated exampleHTTP endpoint wrapperGET /api/v1/namespaces/approvals

GET /api/v1/namespaces/approvals

Signature

list(params?: {
    runId?: string;
    source?: ApprovalSource;
    status?: ApprovalStatus;
    approver?: string;
    limit?: number;
    offset?: number;
  }): Promise<ApprovalListResponse>

Parameters

Name	Type	Flags
params	{ runId?: string; source?: ApprovalSource; status?: ApprovalStatus; approver?: string; limit?: number; offset?: number; }	optional

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

params = {}  # {
    runId?: string;
    source?: ApprovalSource;
    status?: ApprovalStatus;
    approver?: string;
    limit?: number;
    offset?: number;
  }

response = platform.approvals.list(params)
print(response)

Response

// Response type
Promise<ApprovalListResponse>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

approvals.resolve()

Generated exampleHTTP endpoint wrapperPOST /api/v1/approvals/{approvalId}/resolve

POST /api/v1/approvals/{approvalId}/resolve

Signature

resolve(approvalId: string, input: ApprovalResolveInput): Promise<ApprovalResolveResponse>

Parameters

Name	Type	Flags
approvalId	string	required
input	ApprovalResolveInput	required

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

approvalId = "<approvalId>"
input = {}  # ApprovalResolveInput

response = platform.approvals.resolve(approvalId, input)
print(response)

Response

// Response type
Promise<ApprovalResolveResponse>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

approvals.getConfig()

Generated exampleHTTP endpoint wrapperGET /api/v1/namespaces/approvals

GET /api/v1/namespaces/approvals

Signature

getConfig(): Promise<{ data: ApprovalConfig | null }>

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

response = platform.approvals.getConfig()
print(response)

Response

// Response type
Promise<{ data: ApprovalConfig | null }>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

approvals.updateConfig()

Generated exampleHTTP endpoint wrapperPOST /api/v1/namespaces/approvals

POST /api/v1/namespaces/approvals

Signature

updateConfig(input: ApprovalConfigInput): Promise<{ data: ApprovalConfig }>

Parameters

Name	Type	Flags
input	ApprovalConfigInput	required

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

input = {}  # ApprovalConfigInput

response = platform.approvals.updateConfig(input)
print(response)

Response

// Response type
Promise<{ data: ApprovalConfig }>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));