github.com/twilio/twilio-go@v1.20.1/rest/trusthub/v1/docs/CustomerProfilesEvaluationsApi.md (about)

     1  # CustomerProfilesEvaluationsApi
     2  
     3  All URIs are relative to *https://trusthub.twilio.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateCustomerProfileEvaluation**](CustomerProfilesEvaluationsApi.md#CreateCustomerProfileEvaluation) | **Post** /v1/CustomerProfiles/{CustomerProfileSid}/Evaluations | 
     8  [**FetchCustomerProfileEvaluation**](CustomerProfilesEvaluationsApi.md#FetchCustomerProfileEvaluation) | **Get** /v1/CustomerProfiles/{CustomerProfileSid}/Evaluations/{Sid} | 
     9  [**ListCustomerProfileEvaluation**](CustomerProfilesEvaluationsApi.md#ListCustomerProfileEvaluation) | **Get** /v1/CustomerProfiles/{CustomerProfileSid}/Evaluations | 
    10  
    11  
    12  
    13  ## CreateCustomerProfileEvaluation
    14  
    15  > TrusthubV1CustomerProfileEvaluation CreateCustomerProfileEvaluation(ctx, CustomerProfileSidoptional)
    16  
    17  
    18  
    19  Create a new Evaluation
    20  
    21  ### Path Parameters
    22  
    23  
    24  Name | Type | Description
    25  ------------- | ------------- | -------------
    26  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    27  **CustomerProfileSid** | **string** | The unique string that we created to identify the CustomerProfile resource.
    28  
    29  ### Other Parameters
    30  
    31  Other parameters are passed through a pointer to a CreateCustomerProfileEvaluationParams struct
    32  
    33  
    34  Name | Type | Description
    35  ------------- | ------------- | -------------
    36  **PolicySid** | **string** | The unique string of a policy that is associated to the customer_profile resource.
    37  
    38  ### Return type
    39  
    40  [**TrusthubV1CustomerProfileEvaluation**](TrusthubV1CustomerProfileEvaluation.md)
    41  
    42  ### Authorization
    43  
    44  [accountSid_authToken](../README.md#accountSid_authToken)
    45  
    46  ### HTTP request headers
    47  
    48  - **Content-Type**: application/x-www-form-urlencoded
    49  - **Accept**: application/json
    50  
    51  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    52  [[Back to Model list]](../README.md#documentation-for-models)
    53  [[Back to README]](../README.md)
    54  
    55  
    56  ## FetchCustomerProfileEvaluation
    57  
    58  > TrusthubV1CustomerProfileEvaluation FetchCustomerProfileEvaluation(ctx, CustomerProfileSidSid)
    59  
    60  
    61  
    62  Fetch specific Evaluation Instance.
    63  
    64  ### Path Parameters
    65  
    66  
    67  Name | Type | Description
    68  ------------- | ------------- | -------------
    69  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    70  **CustomerProfileSid** | **string** | The unique string that we created to identify the customer_profile resource.
    71  **Sid** | **string** | The unique string that identifies the Evaluation resource.
    72  
    73  ### Other Parameters
    74  
    75  Other parameters are passed through a pointer to a FetchCustomerProfileEvaluationParams struct
    76  
    77  
    78  Name | Type | Description
    79  ------------- | ------------- | -------------
    80  
    81  ### Return type
    82  
    83  [**TrusthubV1CustomerProfileEvaluation**](TrusthubV1CustomerProfileEvaluation.md)
    84  
    85  ### Authorization
    86  
    87  [accountSid_authToken](../README.md#accountSid_authToken)
    88  
    89  ### HTTP request headers
    90  
    91  - **Content-Type**: Not defined
    92  - **Accept**: application/json
    93  
    94  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
    95  [[Back to Model list]](../README.md#documentation-for-models)
    96  [[Back to README]](../README.md)
    97  
    98  
    99  ## ListCustomerProfileEvaluation
   100  
   101  > []TrusthubV1CustomerProfileEvaluation ListCustomerProfileEvaluation(ctx, CustomerProfileSidoptional)
   102  
   103  
   104  
   105  Retrieve a list of Evaluations associated to the customer_profile resource.
   106  
   107  ### Path Parameters
   108  
   109  
   110  Name | Type | Description
   111  ------------- | ------------- | -------------
   112  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   113  **CustomerProfileSid** | **string** | The unique string that we created to identify the CustomerProfile resource.
   114  
   115  ### Other Parameters
   116  
   117  Other parameters are passed through a pointer to a ListCustomerProfileEvaluationParams struct
   118  
   119  
   120  Name | Type | Description
   121  ------------- | ------------- | -------------
   122  **PageSize** | **int** | How many resources to return in each list page. The default is 50, and the maximum is 1000.
   123  **Limit** | **int** | Max number of records to return.
   124  
   125  ### Return type
   126  
   127  [**[]TrusthubV1CustomerProfileEvaluation**](TrusthubV1CustomerProfileEvaluation.md)
   128  
   129  ### Authorization
   130  
   131  [accountSid_authToken](../README.md#accountSid_authToken)
   132  
   133  ### HTTP request headers
   134  
   135  - **Content-Type**: Not defined
   136  - **Accept**: application/json
   137  
   138  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
   139  [[Back to Model list]](../README.md#documentation-for-models)
   140  [[Back to README]](../README.md)
   141