Skip to content

Cards.md

Latest commit

 

History

History
62 lines (46 loc) · 2.47 KB

Cards.md

File metadata and controls

62 lines (46 loc) · 2.47 KB
Raw

Cards — operations

Accessor: client.Cards · Source: src/Square/Api/Cards.cs · 4 operations

Type sources: the file declaring each type an operation names (RawError excluded — see sdk-map.md).

CreateCard

  • Auth: options.Oauth2
  • Signature: CreateCard(CreateCardOperationRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
    • required: Body
  • Returns: CreateCardResponse
  • Error: ApiException<RawError> — Case B
Type Source
CreateCardOperationRequest src/Square/Requests/Cards/CreateCardOperationRequest.cs
CreateCardRequest src/Square/Models/CreateCardRequest.cs
CreateCardResponse src/Square/Models/CreateCardResponse.cs

DisableCard

  • Auth: options.Oauth2
  • Signature: DisableCard(DisableCardRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
    • required: CardId
  • Returns: DisableCardResponse
  • Error: ApiException<RawError> — Case B
Type Source
DisableCardRequest src/Square/Requests/Cards/DisableCardRequest.cs
DisableCardResponse src/Square/Models/DisableCardResponse.cs

ListCards

  • Auth: options.Oauth2
  • Signature: ListCards(ListCardsRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
  • Query params (wire ← C#): cursor ← Cursor, customer_id ← CustomerId, include_disabled ← IncludeDisabled, reference_id ← ReferenceId, sort_order ← SortOrder
  • Returns: ListCardsResponse
  • Error: ApiException<RawError> — Case B
Type Source
ListCardsRequest src/Square/Requests/Cards/ListCardsRequest.cs
SortOrder src/Square/Models/Enums/SortOrder.cs
ListCardsResponse src/Square/Models/ListCardsResponse.cs

RetrieveCard

  • Auth: options.Oauth2
  • Signature: RetrieveCard(RetrieveCardRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
    • required: CardId
  • Returns: RetrieveCardResponse
  • Error: ApiException<RawError> — Case B
Type Source
RetrieveCardRequest src/Square/Requests/Cards/RetrieveCardRequest.cs
RetrieveCardResponse src/Square/Models/RetrieveCardResponse.cs