Skip to content

CustomerSegments.md

Latest commit

 

History

History
34 lines (24 loc) · 1.5 KB

CustomerSegments.md

File metadata and controls

34 lines (24 loc) · 1.5 KB
Raw

CustomerSegments — operations

Accessor: client.CustomerSegments · Source: src/Square/Api/CustomerSegments.cs · 2 operations

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

ListCustomerSegments

  • Auth: options.Oauth2
  • Signature: ListCustomerSegments(ListCustomerSegmentsRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
  • Query params (wire ← C#): cursor ← Cursor, limit ← Limit
  • Returns: ListCustomerSegmentsResponse
  • Error: ApiException<RawError> — Case B
Type Source
ListCustomerSegmentsRequest src/Square/Requests/CustomerSegments/ListCustomerSegmentsRequest.cs
ListCustomerSegmentsResponse src/Square/Models/ListCustomerSegmentsResponse.cs

RetrieveCustomerSegment

  • Auth: options.Oauth2
  • Signature: RetrieveCustomerSegment(RetrieveCustomerSegmentRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
    • required: SegmentId
  • Returns: RetrieveCustomerSegmentResponse
  • Error: ApiException<RawError> — Case B
Type Source
RetrieveCustomerSegmentRequest src/Square/Requests/CustomerSegments/RetrieveCustomerSegmentRequest.cs
RetrieveCustomerSegmentResponse src/Square/Models/RetrieveCustomerSegmentResponse.cs