Class ByProjectKeyPaymentIntegrationsRequestBuilder

Index

Constructors

Properties

Methods

get post withId withKey

Constructors

constructor

new ByProjectKeyPaymentIntegrationsRequestBuilder(
    args: {
        baseUri?: string;
        executeRequest: executeRequest;
        pathArgs: { projectKey: string };
    },
): ByProjectKeyPaymentIntegrationsRequestBuilder
Parameters
- args: {
      baseUri?: string;
      executeRequest: executeRequest;
      pathArgs: { projectKey: string };
  }
Returns ByProjectKeyPaymentIntegrationsRequestBuilder
- Defined in generated/client/payment-integrations/by-project-key-payment-integrations-request-builder.ts:18

Properties

`Protected` `Readonly`args

args: {
    baseUri?: string;
    executeRequest: executeRequest;
    pathArgs: { projectKey: string };
}

Methods

get

get(
    methodArgs?: {
        headers?: { [key: string]: string | string[] };
        queryArgs?: {
            limit?: number;
            offset?: number;
            sort?: string | string[];
            withTotal?: boolean;
            [key: string]: QueryParam;
        };
    },
): ApiRequest<PaginatedPaymentIntegration>
Retrieves Payment Integrations in a Project.
```
The results are [paginated](/../api/general-concepts#pagination).
```
Parameters
- OptionalmethodArgs: {
      headers?: { [key: string]: string | string[] };
      queryArgs?: {
          limit?: number;
          offset?: number;
          sort?: string | string[];
          withTotal?: boolean;
          [key: string]: QueryParam;
      };
  }
Returns ApiRequest<PaginatedPaymentIntegration>
- Defined in generated/client/payment-integrations/by-project-key-payment-integrations-request-builder.ts:58

post

post(
    methodArgs: {
        body: PaymentIntegrationDraft;
        headers?: { [key: string]: string | string[] };
    },
): ApiRequest<PaymentIntegration>
Creates a new PaymentIntegration.
Parameters
- methodArgs: {
  body: PaymentIntegrationDraft;
  headers?: { [key: string]: string | string[] };
  }
Returns ApiRequest<PaymentIntegration>
- Defined in generated/client/payment-integrations/by-project-key-payment-integrations-request-builder.ts:88

withId

withId(
childPathArgs: { id: string },
): ByProjectKeyPaymentIntegrationsByIdRequestBuilder
Parameters
- childPathArgs: { id: string }
Returns ByProjectKeyPaymentIntegrationsByIdRequestBuilder
- Defined in generated/client/payment-integrations/by-project-key-payment-integrations-request-builder.ts:27

withKey

withKey(
childPathArgs: { key: string },
): ByProjectKeyPaymentIntegrationsKeyByKeyRequestBuilder
Parameters
- childPathArgs: { key: string }
Returns ByProjectKeyPaymentIntegrationsKeyByKeyRequestBuilder
- Defined in generated/client/payment-integrations/by-project-key-payment-integrations-request-builder.ts:39