cardscan_client

The official documentation for the CardScan Dart Client.

This Dart package is automatically generated by the OpenAPI Generator project:

API version: 1.0.0
Generator version: 7.7.0
Build package: org.openapitools.codegen.languages.DartDioClientCodegen

Requirements

Dart 2.15.0+ or Flutter 2.8.0+
Dio 5.0.0+ (pub.dev/packages/dio)

Installation & Usage

pub.dev

To use the package from pub.dev, please include the following in pubspec.yaml

dependencies:
  cardscan_client: 1.0.0

Github

If this Dart package is published to Github, please include the following in pubspec.yaml

dependencies:
  cardscan_client:
    git:
      url: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
      #ref: main

Local development

To use the package from your local drive, please include the following in pubspec.yaml

dependencies:
  cardscan_client:
    path: /path/to/cardscan_client

Getting Started

Please follow the installation procedure and then run the following:

import 'package:cardscan_client/cardscan_client.dart';


final api = CardscanClient().getCardScanApi();
final String cardId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
final JsonObject body = Object; // JsonObject |

try {
    final response = await api.cardPerformance(cardId, body);
    print(response);
} catch on DioException (e) {
    print("Exception when calling CardScanApi->cardPerformance: $e\n");
}

Documentation for API Endpoints

All URIs are relative to sandbox.cardscan.ai/v1

Class	Method	HTTP request	Description
CardScanApi	cardPerformance	POST /cards/{card_id}/performance	Card - Send performance data
CardScanApi	createCard	POST /cards	Creates a new card
CardScanApi	createEligibility	POST /eligibility	Create Eligibility Record
CardScanApi	deleteCardById	DELETE /cards/{card_id}	Delete Card
CardScanApi	directUpload	POST /cards/{card_id}/upload	Direct Upload
CardScanApi	generateCardUploadUrl	POST /cards/{card_id}/generate-upload-url	Card - Generate Upload URL
CardScanApi	generateMagicLink	GET /generate-magic-link	Generate Magic Link
CardScanApi	generateUploadUrl	GET /generate-upload-url	Generate an upload URL
CardScanApi	getAccessToken	GET /access-token	Access Token
CardScanApi	getCardById	GET /cards/{card_id}	Get Card by ID
CardScanApi	getEligibilityById	GET /eligibility/{eligibility_id}	Get Eligibility
CardScanApi	getScanMetadata	GET /scans/{scan_id}/metadata	Get Scan Metadata
CardScanApi	listCards	GET /cards	List Cards
CardScanApi	listEligibility	GET /eligibility	List Eligibility
CardScanApi	searchCards	GET /cards/search	Search Cards (200) OK
CardScanApi	validateMagicLink	GET /validate-magic-link	Validate Magic Link