Skip to content

admin-apps.md

Latest commit

 

History

History
62 lines (48 loc) · 3.6 KB

admin-apps.md

File metadata and controls

62 lines (48 loc) · 3.6 KB
Raw

AdminApps — operations

Accessor: client.adminApps · Source: src/resources/admin-apps.ts · 2 operations · Request and error types: namespace AdminApps

Type sources: every type an operation names, with the file that declares it and the schema value exported beside it. Import every name from slack-web-api; the Source path is where to read the shape, never what to import. ApiError, the runtime error family and the file vocabulary are excluded — see sdk-map.md.

adminAppsApprove

  • Signature: adminAppsApprove(request: AdminApps.AdminAppsApproveRequest, options?: RequestOptions): ApiPromise<Defaultsuccesstemplate, AdminApps.AdminAppsApproveError>
  • Wire: POST /admin.apps.approve
  • Auth: slackAuth
  • Request body: application/x-www-form-urlencoded;charset=UTF-8 — every field marked form
  • SDK-sent: header Idempotency-Key (minted per call)
  • Returns: Defaultsuccesstemplate
  • Error: SlackWebApiError with kind: "api", an instance of AdminApps.AdminAppsApproveError — typed arms, narrowed on err.payload.kind
  • Error arms: "defaulterrortemplate1" [default — any status no arm above covers] Defaulterrortemplate1 · "undeclared" [a default-matched body that did not fit Defaulterrortemplate1] rawBody: ArrayBuffer

Fields — AdminApps.AdminAppsApproveRequest (5):

Field Channel Wire Type Req
token header — string yes
contentType header Content-Type ContentType yes
appId form app_id string no
requestId form request_id string no
teamId form team_id string no
Type Schema value Source
ContentType contentTypeSchema src/models/content-type.ts
Defaultsuccesstemplate defaultsuccesstemplateSchema src/models/defaultsuccesstemplate.ts
Defaulterrortemplate1 defaulterrortemplate1Schema src/models/defaulterrortemplate1.ts

adminAppsRestrict

  • Signature: adminAppsRestrict(request: AdminApps.AdminAppsRestrictRequest, options?: RequestOptions): ApiPromise<Defaultsuccesstemplate, AdminApps.AdminAppsRestrictError>
  • Wire: POST /admin.apps.restrict
  • Auth: slackAuth
  • Request body: application/x-www-form-urlencoded;charset=UTF-8 — every field marked form
  • SDK-sent: header Idempotency-Key (minted per call)
  • Returns: Defaultsuccesstemplate
  • Error: SlackWebApiError with kind: "api", an instance of AdminApps.AdminAppsRestrictError — typed arms, narrowed on err.payload.kind
  • Error arms: "defaulterrortemplate1" [default — any status no arm above covers] Defaulterrortemplate1 · "undeclared" [a default-matched body that did not fit Defaulterrortemplate1] rawBody: ArrayBuffer

Fields — AdminApps.AdminAppsRestrictRequest (5):

Field Channel Wire Type Req
token header — string yes
contentType header Content-Type ContentType yes
appId form app_id string no
requestId form request_id string no
teamId form team_id string no
Type Schema value Source
ContentType contentTypeSchema src/models/content-type.ts
Defaultsuccesstemplate defaultsuccesstemplateSchema src/models/defaultsuccesstemplate.ts
Defaulterrortemplate1 defaulterrortemplate1Schema src/models/defaulterrortemplate1.ts